Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: add prefix to packages story titles #252

Merged
merged 2 commits into from
Oct 24, 2024

Conversation

dmytrokirpa
Copy link
Contributor

@dmytrokirpa dmytrokirpa commented Oct 23, 2024

  1. Remove the unnecessary docs property from apps/docsite/project.json.
  2. For package stories titles, adopt the Packages/ format to ensure a consistent structure on the docsite.
  3. Modify the nx-plugin storybook generator to utilize the template for story titles.

Before:
image

After:
image

@dmytrokirpa dmytrokirpa marked this pull request as ready for review October 23, 2024 09:33
@dmytrokirpa dmytrokirpa requested review from mainframev and a team as code owners October 23, 2024 09:33
@dmytrokirpa dmytrokirpa self-assigned this Oct 23, 2024
@dmytrokirpa dmytrokirpa added documentation Improvements or additions to documentation @fluentui-contrib/react-keytips labels Oct 23, 2024
@dmytrokirpa dmytrokirpa requested a review from Hotell October 23, 2024 09:33
component: <%= componentName %>,
};
} satisfies Meta<typeof <%= componentName %>>;
Copy link
Contributor

@mainframev mainframev Oct 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know it's not completely within PR scope, but If this is becoming a standard for this repo, maybe it's worth to quickly align meta types in all packages? Wdyt?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's standard set by official storybook docs, maybe they have it as a rule within their plugin ( https://github.com/storybookjs/eslint-plugin-storybook - they dont 🥹 )

  • please open issue on core repo to implement this enforcement within workspace eslint-rules, once done we can fast-forward to future eslint-plugin-react-components and use it here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dmytrokirpa dmytrokirpa merged commit d047927 into microsoft:main Oct 24, 2024
3 checks passed
@dmytrokirpa dmytrokirpa deleted the fix/docsite-minor-fixes branch October 24, 2024 10:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation @fluentui-contrib/react-keytips
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants